Add _common submodules to OTLP exporter docs (Fixes #2573)#5175
Open
64johnlee wants to merge 2 commits intoopen-telemetry:mainfrom
Open
Add _common submodules to OTLP exporter docs (Fixes #2573)#517564johnlee wants to merge 2 commits intoopen-telemetry:mainfrom
64johnlee wants to merge 2 commits intoopen-telemetry:mainfrom
Conversation
The automodule directives for trace_exporter, metric_exporter, and _log_exporter submodules in both grpc and http were missing :members: :undoc-members: :show-inheritance:, so the API docs for these weren't being generated. Fixes open-telemetry#2786.
Fixes open-telemetry#2573 Adds :automodule: entries for the _common submodules in both the HTTP and gRPC OTLP exporter documentation, so that all exported modules are documented in the Sphinx docs.
|
|
Contributor
|
Thanks @64johnlee ! Please sign the CLA for this one too. I think this will conflict with #5124 which has already been approved, so maybe wait for that to merge first. |
Author
|
I have signed the CLA. Please re-check the EasyCLA status. |
Author
|
CLA signed and email verified. Please re-check EasyCLA status. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2573.
Adds
:automodule:entries for the_commonsubmodules in both the HTTP and gRPC OTLP exporter documentation, so that all exported modules are documented in the Sphinx docs.Changes
In
docs/exporter/otlp/otlp.rst:opentelemetry.exporter.otlp.proto.http._commonopentelemetry.exporter.otlp.proto.grpc._commonBoth now include the standard
:members:,:undoc-members:, and:show-inheritance:directives.